GET v1/Polygons

Returns polygons for given list of sites

URI template

v1/Polygons?siteId[0]={siteId[0]}&siteId[1]={siteId[1]}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	list of site IDs	Collection of integer	Required

Body Parameters

None.

Response Information

Resource Description

list of polygons

Collection of Polygon

Name	Description	Type	Additional information
PolygonId	The Polygon Id	integer	None.
SiteId	The SiteId for the polygon	integer	None.
DesignId	DesignId for the Polygon	integer	None.
SiteGroupId	The SiteGroupId	integer	None.
FeeId	The Fee Id	integer	None.
PolygonCoordinates	List of polygon coordinates	Collection of LatitudeLongitude	None.
ZoomLevel	Zoom level for the map	integer	None.
Fee	Fee information	Fee	None.
ZoneName	Zonename for the polygon	string	None.
DeliveryType	DeliveryType for the polygon	DeliveryType	None.
IsDeliverable	determines if a site is deliverable in the zone	boolean	None.
IsBadWeatherZone	determines if there is bad weather in the zone	boolean	None.
Color	Color of the polygon	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "PolygonId": 1,
    "SiteId": 2,
    "DesignId": 3,
    "SiteGroupId": 4,
    "FeeId": 5,
    "PolygonCoordinates": [
      {
        "$id": "2",
        "SequenceNumber": 6,
        "Latitude": 7.0,
        "Longitude": 8.0
      },
      {
        "$id": "3",
        "SequenceNumber": 9,
        "Latitude": 10.0,
        "Longitude": 11.0
      }
    ],
    "ZoomLevel": 12,
    "Fee": {
      "$id": "4",
      "DesignId": 13,
      "FeeId": 14,
      "Name": "sample string 15",
      "Description": "sample string 16",
      "RevenueItemId": 17,
      "FeeType": 0,
      "Tiers": [
        {
          "$id": "5",
          "FeeTierId": 18,
          "MinimumAmount": 19.0,
          "MaximumAmount": 20.0,
          "FeeAmount": 21.0,
          "FeePercent": 22.0,
          "LastModifiedTimestamp": "2024-05-05T05:49:32.3924645"
        },
        {
          "$id": "6",
          "FeeTierId": 24,
          "MinimumAmount": 25.0,
          "MaximumAmount": 26.0,
          "FeeAmount": 27.0,
          "FeePercent": 28.0,
          "LastModifiedTimestamp": "2024-05-05T05:49:32.3924645"
        }
      ],
      "LastModifiedTimestamp": "2024-05-05T05:49:32.3924645"
    },
    "ZoneName": "sample string 31",
    "DeliveryType": 0,
    "IsDeliverable": true,
    "IsBadWeatherZone": true,
    "Color": "sample string 34"
  },
  {
    "$id": "7",
    "PolygonId": 35,
    "SiteId": 36,
    "DesignId": 37,
    "SiteGroupId": 38,
    "FeeId": 39,
    "PolygonCoordinates": [
      {
        "$id": "8",
        "SequenceNumber": 40,
        "Latitude": 41.0,
        "Longitude": 42.0
      },
      {
        "$id": "9",
        "SequenceNumber": 43,
        "Latitude": 44.0,
        "Longitude": 45.0
      }
    ],
    "ZoomLevel": 46,
    "Fee": {
      "$id": "10",
      "DesignId": 47,
      "FeeId": 48,
      "Name": "sample string 49",
      "Description": "sample string 50",
      "RevenueItemId": 51,
      "FeeType": 0,
      "Tiers": [
        {
          "$id": "11",
          "FeeTierId": 52,
          "MinimumAmount": 53.0,
          "MaximumAmount": 54.0,
          "FeeAmount": 55.0,
          "FeePercent": 56.0,
          "LastModifiedTimestamp": "2024-05-05T05:49:32.3924645"
        },
        {
          "$id": "12",
          "FeeTierId": 58,
          "MinimumAmount": 59.0,
          "MaximumAmount": 60.0,
          "FeeAmount": 61.0,
          "FeePercent": 62.0,
          "LastModifiedTimestamp": "2024-05-05T05:49:32.3924645"
        }
      ],
      "LastModifiedTimestamp": "2024-05-05T05:49:32.3924645"
    },
    "ZoneName": "sample string 65",
    "DeliveryType": 0,
    "IsDeliverable": true,
    "IsBadWeatherZone": true,
    "Color": "sample string 68"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPolygon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <Polygon>
    <Color>sample string 34</Color>
    <DeliveryType>Catering</DeliveryType>
    <DesignId>3</DesignId>
    <Fee xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
      <d3p1:Description>sample string 16</d3p1:Description>
      <d3p1:DesignId>13</d3p1:DesignId>
      <d3p1:FeeId>14</d3p1:FeeId>
      <d3p1:FeeType>Unknown</d3p1:FeeType>
      <d3p1:LastModifiedTimestamp>2024-05-05T05:49:32.3924645</d3p1:LastModifiedTimestamp>
      <d3p1:Name>sample string 15</d3p1:Name>
      <d3p1:RevenueItemId>17</d3p1:RevenueItemId>
      <d3p1:Tiers>
        <d3p1:FeeTier>
          <d3p1:FeeAmount>21</d3p1:FeeAmount>
          <d3p1:FeePercent>22</d3p1:FeePercent>
          <d3p1:FeeTierId>18</d3p1:FeeTierId>
          <d3p1:LastModifiedTimestamp>2024-05-05T05:49:32.3924645</d3p1:LastModifiedTimestamp>
          <d3p1:MaximumAmount>20</d3p1:MaximumAmount>
          <d3p1:MinimumAmount>19</d3p1:MinimumAmount>
        </d3p1:FeeTier>
        <d3p1:FeeTier>
          <d3p1:FeeAmount>27</d3p1:FeeAmount>
          <d3p1:FeePercent>28</d3p1:FeePercent>
          <d3p1:FeeTierId>24</d3p1:FeeTierId>
          <d3p1:LastModifiedTimestamp>2024-05-05T05:49:32.3924645</d3p1:LastModifiedTimestamp>
          <d3p1:MaximumAmount>26</d3p1:MaximumAmount>
          <d3p1:MinimumAmount>25</d3p1:MinimumAmount>
        </d3p1:FeeTier>
      </d3p1:Tiers>
    </Fee>
    <FeeId>5</FeeId>
    <IsBadWeatherZone>true</IsBadWeatherZone>
    <IsDeliverable>true</IsDeliverable>
    <PolygonCoordinates xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
      <d3p1:LatitudeLongitude>
        <d3p1:Latitude>7</d3p1:Latitude>
        <d3p1:Longitude>8</d3p1:Longitude>
        <d3p1:SequenceNumber>6</d3p1:SequenceNumber>
      </d3p1:LatitudeLongitude>
      <d3p1:LatitudeLongitude>
        <d3p1:Latitude>10</d3p1:Latitude>
        <d3p1:Longitude>11</d3p1:Longitude>
        <d3p1:SequenceNumber>9</d3p1:SequenceNumber>
      </d3p1:LatitudeLongitude>
    </PolygonCoordinates>
    <PolygonId>1</PolygonId>
    <SiteGroupId>4</SiteGroupId>
    <SiteId>2</SiteId>
    <ZoneName>sample string 31</ZoneName>
    <ZoomLevel>12</ZoomLevel>
  </Polygon>
  <Polygon>
    <Color>sample string 68</Color>
    <DeliveryType>Catering</DeliveryType>
    <DesignId>37</DesignId>
    <Fee xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
      <d3p1:Description>sample string 50</d3p1:Description>
      <d3p1:DesignId>47</d3p1:DesignId>
      <d3p1:FeeId>48</d3p1:FeeId>
      <d3p1:FeeType>Unknown</d3p1:FeeType>
      <d3p1:LastModifiedTimestamp>2024-05-05T05:49:32.3924645</d3p1:LastModifiedTimestamp>
      <d3p1:Name>sample string 49</d3p1:Name>
      <d3p1:RevenueItemId>51</d3p1:RevenueItemId>
      <d3p1:Tiers>
        <d3p1:FeeTier>
          <d3p1:FeeAmount>55</d3p1:FeeAmount>
          <d3p1:FeePercent>56</d3p1:FeePercent>
          <d3p1:FeeTierId>52</d3p1:FeeTierId>
          <d3p1:LastModifiedTimestamp>2024-05-05T05:49:32.3924645</d3p1:LastModifiedTimestamp>
          <d3p1:MaximumAmount>54</d3p1:MaximumAmount>
          <d3p1:MinimumAmount>53</d3p1:MinimumAmount>
        </d3p1:FeeTier>
        <d3p1:FeeTier>
          <d3p1:FeeAmount>61</d3p1:FeeAmount>
          <d3p1:FeePercent>62</d3p1:FeePercent>
          <d3p1:FeeTierId>58</d3p1:FeeTierId>
          <d3p1:LastModifiedTimestamp>2024-05-05T05:49:32.3924645</d3p1:LastModifiedTimestamp>
          <d3p1:MaximumAmount>60</d3p1:MaximumAmount>
          <d3p1:MinimumAmount>59</d3p1:MinimumAmount>
        </d3p1:FeeTier>
      </d3p1:Tiers>
    </Fee>
    <FeeId>39</FeeId>
    <IsBadWeatherZone>true</IsBadWeatherZone>
    <IsDeliverable>true</IsDeliverable>
    <PolygonCoordinates xmlns:d3p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
      <d3p1:LatitudeLongitude>
        <d3p1:Latitude>41</d3p1:Latitude>
        <d3p1:Longitude>42</d3p1:Longitude>
        <d3p1:SequenceNumber>40</d3p1:SequenceNumber>
      </d3p1:LatitudeLongitude>
      <d3p1:LatitudeLongitude>
        <d3p1:Latitude>44</d3p1:Latitude>
        <d3p1:Longitude>45</d3p1:Longitude>
        <d3p1:SequenceNumber>43</d3p1:SequenceNumber>
      </d3p1:LatitudeLongitude>
    </PolygonCoordinates>
    <PolygonId>35</PolygonId>
    <SiteGroupId>38</SiteGroupId>
    <SiteId>36</SiteId>
    <ZoneName>sample string 65</ZoneName>
    <ZoomLevel>46</ZoomLevel>
  </Polygon>
</ArrayOfPolygon>